/*
   Copyright 2009 Abdulla Abdurakhmanov (abdulla@latestbit.com)
   Original sources are available at www.latestbit.com

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
*/

package org.latestbit.smartobjects.network;

import java.nio.ByteBuffer;

import org.latestbit.smartobjects.exceptions.HandshakeException;

/**
 * Handshake manager provides interface for 
 * connection based handshake procedure implementations 
 * @author abdulla-a
 *
 */
public interface IHandshakeManager {
	/**
	 * Checks if connection already hadnshaked
	 * @return true if handshaked, else false
	 */
	boolean isHandshaked();
	
	/**
	 * Starts handshaking
	 * @throws HandshakeException
	 */
	void beginHandshake( ) throws HandshakeException;
	
	/**
	 * Event occurs when received data from other side
	 * @param buffer input buffer
	 * @throws HandshakeException
	 */
	void onHandshakeReceived ( ByteBuffer buffer ) throws HandshakeException;
	
	/**
	 * Resets handshake manager data
	 */
	void reset();
	
	/**
	 * Gets connection linked with this handshake manager 
	 * @return network connection
	 */
	IConnection getConnection();
}
